Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add unique signatures generation to general parse results #3

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add unique signatures generation to general parse results #3

wants to merge 10 commits into from

Conversation

r-c-n
Copy link
Contributor

@r-c-n r-c-n commented Nov 20, 2024

These changes extend the idea of hash signatures to general parse results, not only errors. This means that all states will now have a unique hash to identify their result based on a set of result fields.

For instance, the generic_boot state collects its key result in the bootloader.done field, so the signature for this result is based on the name and contents of that field.
The kernel_load state has linux.boot.prompt as its key result, so that field will be used to generate the hash key for the state.

Summary fields have also been added to optionally show a human-readable message describing the result.

After logspec goes through a sequence of states, their signature fields will be collected and the hash signature will be generated. The summaries for each state will also be added to a list:

Example: parse a log with the generic_linux_boot parser:

{
    "_match_end": 423922,
    "_signature": "78b6786fda2a517f471e839e93c2c3b17412d089",
    "_signature_fields": [
        "bootloader.done",
        "linux.boot.prompt"
    ],
    "_summary": [
        "Bootloader stage done, jump to kernel",
        "Linux boot prompt found"
    ],
    "bootloader.done": true,
    "errors": [],
    "linux.boot.prompt": true
}

This means that the bootloader finished correctly, handed the execution over to the kernel, the kernel loaded and reached a prompt and no errors were found.

Similar example, this time the kernel didn't reach a prompt:

{
    "_match_end": 374083,
    "_signature": "730f1cab1744a3d79df215388f20b58793a5712c",
    "_signature_fields": [
        "bootloader.done",
        "linux.boot.prompt"
    ],
    "_summary": [
        "Bootloader stage done, jump to kernel",
        "Linux boot prompt not found"
    ],
    "bootloader.done": true,
    "errors": [],
    "linux.boot.prompt": false
}

For logging purposes, if we're interested only in the result of the last state, we can get the last element of the _summary list to get the relevant message.

NOTE that these signatures aren't necessarily related to errors, but to result conditions in general.

r-c-n added 6 commits November 20, 2024 12:41
@r-c-n
Use hash signatures to uniquely identify state results
0086cc0 
Extend the idea of error hash signatures and use it to identify the
parse results of states as well. Each state may define a set of
'signature fields' and, after the parsing is done and the data is
collected, these fields will be used to identify the result set and
generate a unique hash string for them.

These signatures aren't necessarily related to errors, they simply
represent a result.

For now, the new states '_summary', '_signature_fields' and '_signature'
are defined as hidden and are invisible unless the `--json-full` flag is
used.

This change also moves the hash generation to a common utility function.

Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
states/chromebook_boot: define summary messages and signature fields
0dae9a0 
Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
states/generic_boot: define summary messages and signature fields
7c0fcac 
Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
states/linux_kernel: define summary messages and signature fields
ace1a53 
Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
states/test_baseline: define summary messages and signature fields
251642b 
Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
Generate signatures for test_baseline errors
5c0a2a6 
Signed-off-by: Ricardo Cañuelo <[email protected]>
@helen-fornazier
Copy link

iiuc, _summary is just for states right? Should we rename it to _states_summary ?

I'm also wondering if we couldn't have another flag to say we didn't receive any logs from the kernel at all (not only that prompt wasn't reached)

@r-c-n
Copy link
Contributor Author

r-c-n commented Nov 21, 2024

@helen-fornazier thanks for reviewing, answers below:

iiuc, _summary is just for states right? Should we rename it to _states_summary ?

Ah, I thought I had use summary for the errors too, but now that I double check it looks like those are error_summary fields. Yeah, we can change the name, I don't really have a preference.

I'm also wondering if we couldn't have another flag to say we didn't receive any logs from the kernel at all (not only that prompt wasn't reached)

That's something we can try to add yes, let me give it a spin and I'll push some more commits.

r-c-n added 3 commits November 21, 2024 10:42
@r-c-n
logspec/main: collect states summaries into data['_states_summary']
9666569 
Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
states/linux_kernel: detect kernel load start
e59e216 
Add a state data field: linux.boot.kernel_started that will be True if
the parser detects at least one line of kernel log and False if it
doesn't.

Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
tests: sync to latest code changes (linux.boot.kernel_started)
cdd0aa8 
Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
Copy link
Contributor Author

r-c-n commented Nov 21, 2024

@helen-fornazier Done, check out this output for the results of your collected logs with these changes.

@helen-fornazier
Copy link

@helen-fornazier Done, check out this output for the results of your collected logs with these changes.

nice! Looks good! If we could add a "Kernel didn't started" in the summary it would be even better

@r-c-n
states/linux_kernel: summary msg for "kernel didn't start" scenario
6e2bdbb 
Add a summary message for the scenario where the parser can't detect any
kernel output. With this into place, the possible result cases for this
state are:

1) Kernel booted ok and reached a prompt:
   _summary = Linux boot prompt found
2) Kernel produced no output at all:
   _summary = Kernel didn't start
3) Kernel started to load but didn't reach a prompt:
   _summary = Linux boot prompt not found

Signed-off-by: Ricardo Cañuelo <[email protected]>
@r-c-n
Copy link
Contributor Author

r-c-n commented Nov 21, 2024

Done: 6e2bdbb 👍
Updated results here

@helen-fornazier
Copy link

looks good to me, I just want to wait for this PR to be merged if you don't mind

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@r-c-n @helen-fornazier